You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(store): correct misleading and ungrammatical doc comments - #3508
Three comment-only fixes in pkg/store. No behavior changes.
types.go:102 — Rollback deletes x height from the ev-node store. has a leftover x placeholder and does not describe the method. The implementation comment at store.go:250 already says "rolls back block data until the given height"; the interface comment now matches it.
types.go:97 / store.go:219 — GetMetadata returns a single []byte, but the comment said "returns values ... with SetMetadata". Now "returns the value stored for the given key by SetMetadata".
types.go:64 / store.go:184 — "saves arbitrary value" was missing an article; now "saves an arbitrary value".
The interface and implementation copies of the Metadata doc comments are kept in sync. Follows the recent comment cleanups in #3484 and #3479; none of these lines were touched by those changes.
Summary by CodeRabbit
Documentation
Clarified descriptions of metadata storage and retrieval.
Updated rollback documentation to specify the height up to which rollback proceeds.
No actionable comments were generated in the recent review.
Walkthrough
Comments for SetMetadata, GetMetadata, and Rollback were clarified. No declarations or runtime behavior changed.
Changes: Store API comments
Layer / File(s)
Summary
Clarify store API comments pkg/store/store.go, pkg/store/types.go
The comments describe metadata as an arbitrary value, refer to the value stored for a given key, and state that rollback proceeds until the given height.
This is a documentation-only wording cleanup in store comments with no behavior change, so it is safe to merge.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title uses the semantic commit form and names the main change: correcting misleading and ungrammatical doc comments in pkg/store. The changeset only edits comments in pkg/store/store.go and pkg/st…
Description check
The description follows the template's Overview section. It explains the three comment fixes, the reason for each (a leftover 'x' placeholder, a return-type mismatch in GetMetadata, and a missing arti…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title uses the semantic commit form and names the main change: correcting misleading and ungrammatical doc comments in pkg/store. The changeset only edits comments in pkg/store/store.go and pkg/store/types.go, and the description and objectives confirm this scope.
Full details: Description check
Explanation
The description follows the template's Overview section. It explains the three comment fixes, the reason for each (a leftover 'x' placeholder, a return-type mismatch in GetMetadata, and a missing article), and states that there are no behavior changes. It also links related PRs #3484 and #3479. It does not use the template's 'Closes #' issue reference, but the template marks that as an example, and the explanation covers the required context.
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
File: No configuration file from this repository applied
Commit: Unavailable
Layers: defaults
Review profile: CHILL
Plan: Advanced
Run ID: 26a648c0-1473-4cd5-be16-c7349fab4990
Commits
Reviewing files that changed from the base of the PR and between 28d2714 and 1028376.
Files selected for processing: 2
pkg/store/store.go
pkg/store/types.go
Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.
This branch has not been deployed
No deployments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Three comment-only fixes in
pkg/store. No behavior changes.types.go:102—Rollback deletes x height from the ev-node store.has a leftoverxplaceholder and does not describe the method. The implementation comment atstore.go:250already says "rolls back block data until the given height"; the interface comment now matches it.types.go:97/store.go:219—GetMetadatareturns a single[]byte, but the comment said "returns values ... with SetMetadata". Now "returns the value stored for the given key by SetMetadata".types.go:64/store.go:184— "saves arbitrary value" was missing an article; now "saves an arbitrary value".The interface and implementation copies of the
Metadatadoc comments are kept in sync. Follows the recent comment cleanups in #3484 and #3479; none of these lines were touched by those changes.Summary by CodeRabbit